home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XCreateFontCursor.z / XCreateFontCursor
Encoding:
Text File  |  2002-10-03  |  9.7 KB  |  198 lines
  1.  
  2.  
  3.  
  4.      XXXXCCCCrrrreeeeaaaatttteeeeFFFFoooonnnnttttCCCCuuuurrrrssssoooorrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXCCCCrrrreeeeaaaatttteeeeFFFFoooonnnnttttCCCCuuuurrrrssssoooorrrr((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XCreateFontCursor, XCreatePixmapCursor, XCreateGlyphCursor -
  10.           create cursors
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           #include <X11/cursorfont.h>
  14.           Cursor XCreateFontCursor(_d_i_s_p_l_a_y, _s_h_a_p_e)
  15.                 Display *_d_i_s_p_l_a_y;
  16.                 unsigned int _s_h_a_p_e;
  17.  
  18.           Cursor XCreatePixmapCursor(_d_i_s_p_l_a_y, _s_o_u_r_c_e, _m_a_s_k,
  19.           _f_o_r_e_g_r_o_u_n_d__c_o_l_o_r, _b_a_c_k_g_r_o_u_n_d__c_o_l_o_r, _x, _y)
  20.                 Display *_d_i_s_p_l_a_y;
  21.                 Pixmap _s_o_u_r_c_e;
  22.                 Pixmap _m_a_s_k;
  23.                 XColor *_f_o_r_e_g_r_o_u_n_d__c_o_l_o_r;
  24.                 XColor *_b_a_c_k_g_r_o_u_n_d__c_o_l_o_r;
  25.                 unsigned int _x, _y;
  26.  
  27.           Cursor XCreateGlyphCursor(_d_i_s_p_l_a_y, _s_o_u_r_c_e__f_o_n_t, _m_a_s_k__f_o_n_t,
  28.           _s_o_u_r_c_e__c_h_a_r, _m_a_s_k__c_h_a_r,
  29.                                      _f_o_r_e_g_r_o_u_n_d__c_o_l_o_r,
  30.           _b_a_c_k_g_r_o_u_n_d__c_o_l_o_r)
  31.                 Display *_d_i_s_p_l_a_y;
  32.                 Font _s_o_u_r_c_e__f_o_n_t, _m_a_s_k__f_o_n_t;
  33.                 unsigned int _s_o_u_r_c_e__c_h_a_r, _m_a_s_k__c_h_a_r;
  34.                 XColor *_f_o_r_e_g_r_o_u_n_d__c_o_l_o_r;
  35.                 XColor *_b_a_c_k_g_r_o_u_n_d__c_o_l_o_r;
  36.  
  37.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  38.           _b_a_c_k_g_r_o_u_n_d__c_o_l_o_r
  39.                     Specifies the RGB values for the background of the
  40.                     source.
  41.  
  42.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  43.  
  44.           _f_o_r_e_g_r_o_u_n_d__c_o_l_o_r
  45.                     Specifies the RGB values for the foreground of the
  46.                     source.
  47.  
  48.           _m_a_s_k      Specifies the cursor's source bits to be displayed
  49.                     or _N_o_n_e.
  50.  
  51.           _m_a_s_k__c_h_a_r Specifies the glyph character for the mask.
  52.  
  53.           _m_a_s_k__f_o_n_t Specifies the font for the mask glyph or _N_o_n_e.
  54.  
  55.           _s_h_a_p_e     Specifies the shape of the cursor.
  56.  
  57.           _s_o_u_r_c_e    Specifies the shape of the source cursor.
  58.  
  60.  
  61.  
  62.      Page 1                                          (printed 10/3/02)
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.      XXXXCCCCrrrreeeeaaaatttteeeeFFFFoooonnnnttttCCCCuuuurrrrssssoooorrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXCCCCrrrreeeeaaaatttteeeeFFFFoooonnnnttttCCCCuuuurrrrssssoooorrrr((((3333XXXX11111111))))
  70.  
  71.  
  72.  
  73.           _s_o_u_r_c_e__c_h_a_r
  74.                     Specifies the character glyph for the source.
  75.  
  76.           _s_o_u_r_c_e__f_o_n_t
  77.                     Specifies the font for the source glyph.
  78.  
  79.           _x
  80.           _y         Specify the x and y coordinates, which indicate
  81.                     the hotspot relative to the source's origin.
  82.  
  83.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  84.           X provides a set of standard cursor shapes in a special font
  85.           named cursor.  Applications are encouraged to use this
  86.           interface for their cursors because the font can be
  87.           customized for the individual display type.  The shape
  88.           argument specifies which glyph of the standard fonts to use.
  89.  
  90.           The hotspot comes from the information stored in the cursor
  91.           font.  The initial colors of a cursor are a black foreground
  92.           and a white background (see _X_R_e_c_o_l_o_r_C_u_r_s_o_r).
  93.  
  94.           _X_C_r_e_a_t_e_F_o_n_t_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
  95.  
  96.           The _X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r function creates a cursor and
  97.           returns the cursor ID associated with it.  The foreground
  98.           and background RGB values must be specified using
  99.           foreground_color and background_color, even if the X server
  100.           only has a _S_t_a_t_i_c_G_r_a_y or _G_r_a_y_S_c_a_l_e screen.  The foreground
  101.           color is used for the pixels set to 1 in the source, and the
  102.           background color is used for the pixels set to 0.  Both
  103.           source and mask, if specified, must have depth one (or a
  104.           _B_a_d_M_a_t_c_h error results) but can have any root.  The mask
  105.           argument defines the shape of the cursor.  The pixels set to
  106.           1 in the mask define which source pixels are displayed, and
  107.           the pixels set to 0 define which pixels are ignored.  If no
  108.           mask is given, all pixels of the source are displayed.  The
  109.           mask, if present, must be the same size as the pixmap
  110.           defined by the source argument, or a _B_a_d_M_a_t_c_h error results.
  111.           The hotspot must be a point within the source, or a _B_a_d_M_a_t_c_h
  112.           error results.
  113.  
  114.           The components of the cursor can be transformed arbitrarily
  115.           to meet display limitations.  The pixmaps can be freed
  116.           immediately if no further explicit references to them are to
  117.           be made.  Subsequent drawing in the source or mask pixmap
  118.           has an undefined effect on the cursor.  The X server might
  119.           or might not make a copy of the pixmap.
  120.  
  121.           _X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c and _B_a_d_P_i_x_m_a_p
  122.           errors.
  123.  
  124.           The _X_C_r_e_a_t_e_G_l_y_p_h_C_u_r_s_o_r function is similar to
  125.  
  126.  
  127.  
  128.      Page 2                                          (printed 10/3/02)
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.      XXXXCCCCrrrreeeeaaaatttteeeeFFFFoooonnnnttttCCCCuuuurrrrssssoooorrrr((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXCCCCrrrreeeeaaaatttteeeeFFFFoooonnnnttttCCCCuuuurrrrssssoooorrrr((((3333XXXX11111111))))
  136.  
  137.  
  138.  
  139.           _X_C_r_e_a_t_e_P_i_x_m_a_p_C_u_r_s_o_r except that the source and mask bitmaps
  140.           are obtained from the specified font glyphs.  The
  141.           source_char must be a defined glyph in source_font, or a
  142.           _B_a_d_V_a_l_u_e error results.  If mask_font is given, mask_char
  143.           must be a defined glyph in mask_font, or a _B_a_d_V_a_l_u_e error
  144.           results.  The mask_font and character are optional.  The
  145.           origins of the source_char and mask_char (if defined) glyphs
  146.           are positioned coincidently and define the hotspot. The
  147.           source_char and mask_char need not have the same bounding
  148.           box metrics, and there is no restriction on the placement of
  149.           the hotspot relative to the bounding boxes. If no mask_char
  150.           is given, all pixels of the source are displayed.  You can
  151.           free the fonts immediately by calling _X_F_r_e_e_F_o_n_t if no
  152.           further explicit references to them are to be made.
  153.  
  154.           For 2-byte matrix fonts, the 16-bit value should be formed
  155.           with the byte1 member in the most significant byte and the
  156.           byte2 member in the least significant byte.
  157.  
  158.           _X_C_r_e_a_t_e_G_l_y_p_h_C_u_r_s_o_r can generate _B_a_d_A_l_l_o_c, _B_a_d_F_o_n_t, and
  159.           _B_a_d_V_a_l_u_e errors.
  160.  
  161.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  162.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  163.                     resource or server memory.
  164.  
  165.           _B_a_d_F_o_n_t   A value for a Font or GContext argument does not
  166.                     name a defined Font.
  167.  
  168.           _B_a_d_M_a_t_c_h  Some argument or pair of arguments has the correct
  169.                     type and range but fails to match in some other
  170.                     way required by the request.
  171.  
  172.           _B_a_d_P_i_x_m_a_p A value for a Pixmap argument does not name a
  173.                     defined Pixmap.
  174.  
  175.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  176.                     values accepted by the request.  Unless a specific
  177.                     range is specified for an argument, the full range
  178.                     defined by the argument's type is accepted.  Any
  179.                     argument defined as a set of alternatives can
  180.                     generate this error.
  181.  
  182.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  183.           XDefineCursor(3X11), XLoadFont(3X11), XRecolorCursor(3X11)
  184.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.      Page 3                                          (printed 10/3/02)
  195.  
  196.  
  197.  
  198.